fix: update clone instructions and SDK dependencies for all examples - #362
Merged
yash-pouranik merged 7 commits intoJul 26, 2026
Conversation
- Python SDK Demo README: add urBackend/ prefix to cd path - Social Demo README: fix repo URL to geturbackend/urBackend, add urBackend/ prefix - Kanban README: add clone instructions with urBackend/ prefix - Kanban server: replace file: SDK dependency with published 0.4.2 - Templates.jsx: update all readme blocks with correct clone + cd instructions
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughUpdates local setup instructions for React, Kanban, Python, and Social examples, aligns repository and documentation links with the canonical repository, and changes Kanban to use the published SDK version ChangesTemplate setup workflow
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/web-dashboard/src/pages/Templates.jsx`:
- Around line 58-59: Update the Terminal 2 startup instructions in the Templates
page so they first navigate to the urBackend/examples/sdk-kanban example
directory, then install dependencies and start the client; preserve the existing
client startup commands.
- Around line 62-63: Update the setup instructions in Templates.jsx to document
the complete Kanban schema from examples/sdk-kanban/README.md, including
required fields for the boards and tasks collections and RLS configured with
ownerField=ownerId. Keep the existing Auth and collection setup steps while
making the schema and ownership settings explicit enough for the app’s CRUD
operations.
- Around line 55-64: Update the Kanban setup instructions around the
server/client startup commands to configure environment variables first:
document both server/.env.example and client/.env.example, including
VITE_URBACKEND_PK and URBACKEND_SECRET_KEY, and instruct users to create the
corresponding .env files before running npm install and npm start/dev. Mention
that Vite-loaded environment changes require restarting the client server.
In `@examples/sdk-kanban/README.md`:
- Around line 12-19: Renumber the README setup headings following “Dashboard
Setup” so “Environment Variables” becomes step 3 and “Installation & Run”
becomes step 4, preserving the existing heading text and sequence.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: da07707e-6187-420a-a389-13fc30ca9ba2
📒 Files selected for processing (5)
apps/web-dashboard/src/pages/Templates.jsxexamples/python-sdk-demo/README.mdexamples/sdk-kanban/README.mdexamples/sdk-kanban/server/package.jsonexamples/social-demo/README.md
- Environment Variables: step 3 (was incorrectly labeled as 2) - Installation & Run: step 4 (was incorrectly labeled as 3)
…tails - Add environment variable configuration steps (server/.env and client/.env) - Document complete collection schemas with RLS settings - Add note about Vite requiring server restart for env changes - Clarify client startup runs from urBackend/examples/sdk-kanban
yash-pouranik
requested changes
Jul 23, 2026
|
|
||
| ## Setup | ||
| \`\`\`bash | ||
| git clone https://github.com/geturbackend/urBackend.git |
Member
There was a problem hiding this comment.
Useparticular folder cloning.
1. Clone the repository without downloading the files
git clone --no-checkout --depth 1 <repository_url> <destination_folder>
2. Enter the repository directory
cd <destination_folder>
3. Enable sparse-checkout in cone mode
git sparse-checkout init --cone
4. Specify the folder you want to clone
git sparse-checkout set <path/to/desired/folder>
5. Download the files
git checkout main
- Add Option 1: Full Clone (existing method) - Add Option 2: Sparse Checkout (recommended for faster setup) - Sparse checkout clones only the template folder without full repo
Collaborator
Author
yash-pouranik
requested changes
Jul 23, 2026
Comment on lines
26
to
27
| cd urBackend/examples/react-sdk-demo | ||
| npm install |
Member
There was a problem hiding this comment.
You can add the same for all the examples na?
@Nitin-kumar-yadav1307
Member
- React SDK Demo: add Option 1 (Full Clone) and Option 2 (Sparse Checkout) - Social Media Clone: add Option 1 (Full Clone) and Option 2 (Sparse Checkout) - Python SDK Demo: add Option 1 (Full Clone) and Option 2 (Sparse Checkout) - All templates now recommend sparse checkout for faster setup
Contributor
|
@Nitin-kumar-yadav1307 is attempting to deploy a commit to the Yash Pouranik's projects Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/web-dashboard/src/pages/Templates.jsx`:
- Around line 132-153: Complete the Social demo setup content in the Templates
page by including or directly linking to the exact instructions from
examples/social-demo/README.md for VITE_PUBLIC_KEY, VITE_PROXY_URL, API_KEY,
dependency installation, and starting the client and server terminals. Preserve
the existing clone and sparse-checkout options.
- Around line 32-49: The sparse-checkout instructions in the Templates.jsx
examples must change into their selected directories before running setup
commands. In apps/web-dashboard/src/pages/Templates.jsx#L32-L49, add the
react-sdk-demo directory change before npm install; at `#L79-L110`, add the
sdk-kanban directory change before environment setup and startup; at `#L138-L153`,
add the social-demo directory change before local setup; and at `#L185-L206`, add
the python-sdk-demo directory change before pip install.
- Around line 51-52: Update the template dialog copy in Templates.jsx to use the
React SDK’s VITE_UR_PUBLIC_KEY variable instead of VITE_URBACKEND_PK, and direct
users to place it in the default client Vite .env file while preserving the
existing development-server instruction.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 64e14c77-9e03-483f-89fd-efc2e6a46198
📒 Files selected for processing (2)
apps/web-dashboard/src/pages/Templates.jsxexamples/sdk-kanban/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
- examples/sdk-kanban/README.md
- React SDK Demo: add cd examples/react-sdk-demo before npm install, update to VITE_UR_PUBLIC_KEY - Kanban Board: add cd examples/sdk-kanban before environment setup - Social Media Clone: add cd examples/social-demo, add env vars (VITE_PUBLIC_KEY, API_KEY) and run instructions - Python SDK Demo: add cd examples/python-sdk-demo before pip install - All templates now have consistent sparse checkout + directory navigation flow
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fix #360
Overview
This PR fixes the template setup instructions in the urBackend dashboard and example READMEs to ensure users can reliably fetch and run the selected examples from a clean clone.
Problem Statement
The source-based template workflow had inconsistent setup instructions:
cdpathyash-pouranik/urBackendinstead ofgeturbackend/urBackend)file:../../../sdks/urbackend-sdk) which doesn't work outside the monorepoSolution
Updated all example READMEs and dashboard metadata to use consistent, correct clone instructions with the canonical repository URL and proper directory paths.
Files Changed
1.
examples/python-sdk-demo/README.mdChange: Added
urBackend/prefix to cd path2.
examples/social-demo/README.mdChanges:
https://github.com/geturbackend/urBackend.giturBackend/prefix to clone pathgeturbackend/urBackend3.
examples/sdk-kanban/README.mdChange: Added clone instructions with correct path
4.
examples/sdk-kanban/server/package.jsonChange: Replaced local file dependency with published package
5.
apps/web-dashboard/src/pages/Templates.jsxChange: Updated all template README blocks with correct clone + cd instructions
urBackend/examples/react-sdk-demopathurBackend/examples/python-sdk-demopathAcceptance Criteria
✅ All clone instructions use canonical repository URL
https://github.com/geturbackend/urBackend.git✅ All cd paths include cloned repository directory
cd urBackend/examples/<template-name>✅ Kanban setup succeeds without local SDK dependency
@urbackend/sdk@0.4.2instead of local file reference✅ Template cards and READMEs describe the same workflow
✅ Users can follow instructions from clean shell after cloning
Testing
cdpaths includeurBackend/prefixRelated Issues
Summary by CodeRabbit